home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / afSetVirtualFormatParams.z / afSetVirtualFormatParams
Encoding:
Text File  |  2002-10-03  |  11.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                    aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afSetVirtualFormatParams, afGetVirtualFormatParams - set/get the virtual
  10.      audio data format in an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee for a specified audio track via
  11.      ddddmmmmPPPPaaaarrrraaaammmmssss
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____aaaauuuuddddiiiioooo....hhhh>>>>
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  16.  
  17.      DDDDMMMMssssttttaaaattttuuuussss aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt ttttrrrraaaacccckkkk,,,,
  18.                                        DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  19.  
  20.      DDDDMMMMssssttttaaaattttuuuussss aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee,,,, iiiinnnntttt ttttrrrraaaacccckkkk,,,,
  21.                                        DDDDMMMMppppaaaarrrraaaammmmssss ****ppppaaaarrrraaaammmmssss))))
  22.  
  23. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  24.      _f_i_l_e     is an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure, previously created by a call to
  25.               aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm) or its equivalent.
  26.  
  27.      _t_r_a_c_k    is an integer which identifies an audio track in _f_i_l_e.
  28.  
  29.               Since all currently supported file formats contain only one
  30.               audio track, the value AAAAFFFF____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTRRRRAAAACCCCKKKK should be used here for
  31.               now.
  32.  
  33.      _p_a_r_a_m_s   a DDDDMMMMppppaaaarrrraaaammmmssss list, previously created by a call to
  34.               ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee(3dm).
  35.  
  36. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  37.      aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) and aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) return
  38.      DM_SUCCESS on success, otherwise they return DM_FAILURE.
  39.  
  40. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  41.      When a audio data is read from a file into the application's data buffer
  42.      using aaaaffffRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss(3dm), or written into a file via aaaaffffWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss(3dm),
  43.      the format of the data in the application's buffer can vary independently
  44.      of the actual file data format.  This independent format is call the
  45.      _v_i_r_t_u_a_l _f_o_r_m_a_t of the data.  Once some aspect of the virtual data format
  46.      is set via one of the above-described routines, the conversion to and
  47.      from the file format into the virtual format happens automatically and
  48.      transparently.  This allows an application to choose to ignore the actual
  49.      file format entirely, and specify only the format in which it wants the
  50.      data to appear in the afReadFrames(3dm) buffer.  See afIntro(3dm) for
  51.      more information about the virtual format.
  52.  
  53.      aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) sets all virtual parameters associated with
  54.      the audio data in an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure for an audio track.  It
  55.      obsoletes the individual routines aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllSSSSaaaammmmpppplllleeeeFFFFoooorrrrmmmmaaaatttt(3dm),
  56.      aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllCCCChhhhaaaannnnnnnneeeellllssss(3dm), aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllRRRRaaaatttteeee(3dm), and
  57.      aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllPPPPCCCCMMMMMMMMaaaappppppppiiiinnnngggg(3dm).
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))                    aaaaffffSSSSeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllFFFFoooorrrrmmmmaaaattttPPPPaaaarrrraaaammmmssss(((()))) allows an application to retrieve the complete
  75.      set of virtual params currently contained within an AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee
  76.      structure for a given track.
  77.  
  78.      The following parameters are defined in _d_m_e_d_i_a/_d_m__a_u_d_i_o._h and may be set
  79.      or retrieved via _p_a_r_a_m_s:
  80.  
  81.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFOOOORRRRMMMMAAAATTTT       Sample format.  Must be DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____TTTTWWWWOOOOSSSS____CCCCOOOOMMMMPPPPEEEEMMMMEEEENNNNTTTT,
  82.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNSSSSIIIIGGGGNNNNEEEEDDDD, DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT, or
  83.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE.
  84.  
  85.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____WWWWIIIIDDDDTTTTHHHH        Sample width in bits.  For integer sample formats,
  86.                            it must be an integer value between 1 and 32,
  87.                            inclusive.  For formats DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____FFFFLLLLOOOOAAAATTTT and
  88.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____DDDDOOOOUUUUBBBBLLLLEEEE, this parameter is ignored.
  89.  
  90.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCHHHHAAAANNNNNNNNEEEELLLLSSSS     Channel count.  Integer value greater than or equal
  91.                            to 1.
  92.  
  93.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____RRRRAAAATTTTEEEE         Sampling rate.  Must be a positive, double
  94.                            precision floating point value.
  95.  
  96.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____CCCCOOOOMMMMPPPPRRRREEEESSSSSSSSIIIIOOOONNNN  Compression type.  Must be left unset or set to
  97.                            DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____UUUUNNNNCCCCOOOOMMMMPPPPRRRREEEESSSSSSSSEEEEDDDD, since all data returned via
  98.                            aaaaffffRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss(3dm) or handed to aaaaffffWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss(3dm)
  99.                            must be uncompressed.
  100.  
  101.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____SSSSLLLLOOOOPPPPEEEE
  102.  
  103.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____IIIINNNNTTTTEEEERRRRCCCCEEEEPPPPTTTT
  104.  
  105.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMAAAAXXXXCCCCLLLLIIIIPPPP
  106.  
  107.      DDDDMMMM____AAAAUUUUDDDDIIIIOOOO____PPPPCCCCMMMM____MMMMAAAAPPPP____MMMMIIIINNNNCCCCLLLLIIIIPPPP
  108.                            Slope, intercept, minimum and maximum clipping
  109.                            values for PCM mapping (see
  110.                            aaaaffffGGGGeeeettttVVVViiiirrrrttttuuuuaaaallllPPPPCCCCMMMMMMMMaaaappppppppiiiinnnngggg(3dm) for a detailed
  111.                            explanation).
  112.  
  113. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  114.      The Audio File Library will continue to support additional file formats.
  115.      The ability of these file formats to store data of various sample formats
  116.      will vary.  If you are choosing a file format other than the default
  117.      format, you should make sure that you either explicitly specify format
  118.      params for this file's tracks which are compatible with that file format,
  119.      or do not set them at all (in which case they will be set to default
  120.      values for the format).
  121.  
  122. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  123.      afNewFileSetup(3dm), afOpenFile(3dm), afWriteFrames(3dm),
  124.      afInitFormatParams(3dm), afSetConversionParams(3dm)
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.